fix(38312): Update dependencies as indicated by Snyk #39372

allroundexperts · 2024-04-01T18:39:19Z

Details

The original PR (created by Snyk automatically) had conflicts. As such, raising a new PR with those changes.

Fixed Issues

$ #38311
$ https://github.com/Expensify/Expensify/issues/366633
$ https://github.com/Expensify/Expensify/issues/366623
PROPOSAL: N/A

Tests

Run npm install
Then run npm run storybook
Verify that the storybook opens and run fine.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Go to https://staging.new.expensify.com/docs/index.html and make sure it loads

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-04-01T18:39:45Z

@cristipaval Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

yuwenmemon · 2024-04-01T18:42:51Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

allroundexperts · 2024-04-01T18:44:40Z

Hold off a sec. I think I forgot to update storybook dependency.

allroundexperts · 2024-04-01T21:40:53Z

package.json

+    "@babel/plugin-proposal-private-methods": "^7.18.6",
+    "@babel/plugin-proposal-private-property-in-object": "^7.21.11",


These were required for our jest test and existed as a peer dependency of storybook v6. Since the latest version does not contain this, I added them explicitly as a dependency.

allroundexperts · 2024-04-01T22:32:18Z

Ready now @yuwenmemon

allroundexperts · 2024-04-01T22:32:50Z

Given the changes, I think it would be helpful for a C+ to help with the testing. The changes are mostly related to types.

melvin-bot · 2024-04-02T00:44:52Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

melvin-bot · 2024-04-02T00:44:54Z

Hey, I noticed you changed some webpack configuration files. This can break production builds. Did you remember to run a production build locally to verify they still work?

.storybook/main.ts

__mocks__/@react-navigation/native/index.ts

pecanoro · 2024-04-02T03:11:16Z

src/stories/Form.stories.tsx

    title: 'Components/Form',
    component: FormProvider,
    subcomponents: {
+        // @ts-expect-error Subcomponent passes props with unknown type causing a TS error


This is not a blocker or anything, just wondering why we need this.

The following type error occurs without it:

Hehe yes, but why is the type wrong? Or is this expected somehow?

I think there is something wrong indeed:

eh2077 · 2024-04-02T08:40:19Z

.storybook/main.ts

-
-const main: Main = {
-    stories: ['../src/**/*.stories.mdx', '../src/**/*.stories.@(js|jsx|ts|tsx)'],
-    addons: ['@storybook/addon-essentials', '@storybook/addon-a11y', '@storybook/addon-react-native-web'],


Would you like to share your consideration to remove this addon @storybook/addon-react-native-web? Is it because there's no entry command in package.json to run storybook on native platforms (no usage on native platforms) ?

That's correct. I wasn't able to find this being used anywhere.

eh2077 · 2024-04-02T09:32:42Z

.storybook/theme.ts

@@ -13,6 +13,7 @@ const theme: ThemeVars = create({
    colorPrimary: colors.productDark400,
    colorSecondary: colors.green,
    appContentBg: colors.productDark100,
+    appPreviewBg: colors.productDark100,


When I build production storybook via npm run storybook-build and then cd to ./dist/docs and run npx serve to access the storybook, the No Preview message in the home page is not easy to read

The empty preview page looks like below if this is removed

But I agree with this style added, the preview looks prettier

Default background Background productDark100

I found that the dev cmd storybook dev automatically redirects to preview the first component. Maybe we can omit this if the production endpoint of storybook is also able to auto redirect to a preview of a component.

Hmm, I found that there's an option to change the background color of the preview area. So, I'm inclined not to incorporate this style.

Screen.Recording.2024-04-02.at.5.52.01.PM.mov

@eh2077 This is an issue with the serve library. See more here. Using npx http-server works perfectly.

@allroundexperts Oh, yes, npx http-server works well!

eh2077 · 2024-04-03T15:52:25Z

@allroundexperts Friendly bump. And there're conflicts need to be resolved.

pecanoro · 2024-04-08T13:33:30Z

@allroundexperts Another friendly bump here!

allroundexperts · 2024-04-09T10:54:23Z

Why does it have no QA steps or tests? We need to make sure storybook still works, right? For tests you can say you ran npm run storybook and for QA to go to the storybook and browse to a couple of components to make sure it does not throw and loads properly

Added.

pecanoro · 2024-04-09T11:49:33Z

src/stories/Form.stories.tsx

    title: 'Components/Form',
    component: FormProvider,
    subcomponents: {
+        // @ts-expect-error Subcomponent passes props with unknown type causing a TS error


I think there is something wrong indeed:

allroundexperts · 2024-04-09T12:56:49Z

@pecanoro This same error exists on main as well. I don't think this has to do with the version update. We can fix it in a follow up PR if you'd like.

eh2077 · 2024-04-10T01:17:10Z

@allroundexperts There're conflicts need to be resolved.

pecanoro · 2024-04-10T09:03:56Z

Ugh damn, I was waiting for the tests to finish running and I didn't merge, now we have conflicts, I am sorry!

allroundexperts · 2024-04-10T10:06:12Z

No worries. Resolved the conflicts!

allroundexperts · 2024-04-10T10:22:28Z

All tests passing. @pecanoro Good to merge!

pecanoro · 2024-04-10T11:05:06Z

Tested again and it seems to be working! Merging since @yuwenmemon is OOO for the whole week and we don't want more conflicts! Thank you everyone!

OSBotify · 2024-04-10T11:13:09Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-04-10T17:46:09Z

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.4.62-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2024-04-10T17:55:02Z

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.4.62-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2024-04-10T19:34:16Z

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.4.62-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

Julesssss · 2024-04-11T10:01:07Z

I'm not sure if this is related or not, but the test steps failed when QA can't access https://staging.new.expensify.com/docs/index.html

@eh2077 @allroundexperts @pecanoro please could you take a look and see if you think of a fix for the deploy blocker issue

allroundexperts · 2024-04-11T10:54:36Z

Checking this now @Julesssss

allroundexperts · 2024-04-11T10:55:56Z

@Julesssss Is the deploy blocker link you shared is correct?

allroundexperts · 2024-04-11T11:01:12Z

This is the error I get in console. It looks like the issue is with how we're deploying this. It's building fine locally. Do you know how we are deploying this currently?

pecanoro · 2024-04-15T14:07:13Z

@Julesssss Did you check if it was related to the deploy process? Since it's working locally, maybe it's related to that as @allroundexperts suggested

pecanoro · 2024-04-15T14:09:31Z

package.json

-    "storybook-build-staging": "ENV=staging build-storybook -o dist/docs",
+    "storybook": "storybook dev -p 6006",
+    "storybook-build": "ENV=production storybook build -o dist/docs",
+    "storybook-build-staging": "ENV=staging storybook build -o dist/docs",


Did you try building it to see if this is what caused the storybook not to load?

pecanoro · 2024-04-15T14:12:06Z

@allroundexperts By the way, those console errors are also in production so it must be something else

OSBotify · 2024-04-18T04:32:00Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.62-17 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

Julesssss · 2024-04-23T14:19:15Z

@Julesssss Did you check if it was related to the deploy process? Since it's working locally, maybe it's related to that as @allroundexperts suggested

It seems like this was unrelated. We struggled to reproduce and the issue was closed before the recent deploy 👍

update deps

e1251c6

allroundexperts requested a review from a team as a code owner April 1, 2024 18:39

melvin-bot bot requested review from cristipaval and removed request for a team April 1, 2024 18:39

allroundexperts mentioned this pull request Apr 1, 2024

[Snyk] Fix for 3 vulnerabilities #38312

Closed

yuwenmemon self-requested a review April 1, 2024 18:42

allroundexperts added 3 commits April 2, 2024 01:13

update storybook

86f0ce5

type error

5129cea

type error

a417d7c

allroundexperts commented Apr 1, 2024

View reviewed changes

allroundexperts added 2 commits April 2, 2024 03:11

more finetunings

eb7c2bb

fix: storybook failure

ff61a71

prettier

510dead

yuwenmemon requested a review from eh2077 April 2, 2024 00:22

pecanoro self-requested a review April 2, 2024 00:43

pecanoro requested changes Apr 2, 2024

View reviewed changes

eh2077 reviewed Apr 2, 2024

View reviewed changes

allroundexperts added 3 commits April 8, 2024 19:42

resolve conflicts

0afe4eb

remove un-needed extra lines

e13257f

re-add ts expect error checks

64e701c

cristipaval removed their request for review April 9, 2024 11:41

pecanoro requested changes Apr 9, 2024

View reviewed changes

pecanoro previously approved these changes Apr 9, 2024

View reviewed changes

merge with main

71b43c0

allroundexperts dismissed pecanoro’s stale review via 71b43c0 April 10, 2024 10:05

pecanoro approved these changes Apr 10, 2024

View reviewed changes

pecanoro merged commit e504806 into Expensify:main Apr 10, 2024
19 checks passed

github-actions bot mentioned this pull request Apr 10, 2024

Deploy Checklist: New Expensify 2024-04-10 #40026

Closed

m-natarajan mentioned this pull request Apr 10, 2024

[HOLD E/App #38072] [$250] Storybook - Storybook is displaying a white page upon opening + console errors #40041

Open

6 tasks

lakchote mentioned this pull request Apr 11, 2024

[$250] WS - Profile - Share - Workspace QR code is not downloaded to the device #40080

Closed

6 tasks

pecanoro reviewed Apr 15, 2024

View reviewed changes

		"@babel/plugin-proposal-private-methods": "^7.18.6",
		"@babel/plugin-proposal-private-property-in-object": "^7.21.11",

fix(38312): Update dependencies as indicated by Snyk #39372

fix(38312): Update dependencies as indicated by Snyk #39372

Conversation

allroundexperts commented Apr 1, 2024 • edited by pecanoro Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 1, 2024

yuwenmemon commented Apr 1, 2024

Reviewer Checklist

Screenshots/Videos

allroundexperts commented Apr 1, 2024

Choose a reason for hiding this comment

allroundexperts commented Apr 1, 2024

allroundexperts commented Apr 1, 2024

melvin-bot bot commented Apr 2, 2024

melvin-bot bot commented Apr 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eh2077 Apr 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eh2077 commented Apr 3, 2024

pecanoro commented Apr 8, 2024

allroundexperts commented Apr 9, 2024

Choose a reason for hiding this comment

allroundexperts commented Apr 9, 2024

eh2077 commented Apr 10, 2024

pecanoro commented Apr 10, 2024

allroundexperts commented Apr 10, 2024

allroundexperts commented Apr 10, 2024

pecanoro commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 10, 2024

Julesssss commented Apr 11, 2024 • edited Loading

allroundexperts commented Apr 11, 2024

allroundexperts commented Apr 11, 2024

allroundexperts commented Apr 11, 2024

pecanoro commented Apr 15, 2024

Choose a reason for hiding this comment

pecanoro commented Apr 15, 2024

OSBotify commented Apr 18, 2024

Julesssss commented Apr 23, 2024

allroundexperts commented Apr 1, 2024 •

edited by pecanoro

Loading

eh2077 Apr 2, 2024 •

edited

Loading

Julesssss commented Apr 11, 2024 •

edited

Loading